Class UsbControllerImpl

All Implemented Interfaces:
IPCObject, Process, UsbController

public class UsbControllerImpl extends ProcessImpl implements UsbController
Information provided by the PKI file:

    \class UsbController
    
    \brief UsbController.
    
    \example network().getDevice("PC0").getUsbPortAt(0).getController()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • begin

      public void begin(int speed)
      Information provided by the PKI file:
      
          \brief Start the UsbController
          
          \param speed, the speed at which the Usb Controller is operating at
          
              
      Specified by:
      begin in interface UsbController
      Parameters:
      speed - Takes in a parameter of speed
    • end

      public void end()
      Information provided by the PKI file:
      
          \brief End the UsbController
          
              
      Specified by:
      end in interface UsbController
    • available

      public int available()
      Information provided by the PKI file:
      
          \brief Returns number of bytes available in the buffer
          \return int, number of bytes
          
              
      Specified by:
      available in interface UsbController
      Returns:
      int Returns a int
    • print

      public int print(String value)
      Information provided by the PKI file:
      
          \brief Print string to the console
          \param value, the string to be printed
          \return int, the length of the string
          
              
      Specified by:
      print in interface UsbController
      Parameters:
      value - Takes in a parameter of value
      Returns:
      int Returns a int
    • readLine

      public String readLine()
      Information provided by the PKI file:
      
          \brief Read the next line in the buffer
          \return string, the next line
          
              
      Specified by:
      readLine in interface UsbController
      Returns:
      String Returns a String
    • readChar

      public String readChar()
      Information provided by the PKI file:
      
          \brief Read the next character in the buffer
          \return string, the next character in string format
          
              
      Specified by:
      readChar in interface UsbController
      Returns:
      String Returns a String
    • peekChar

      public String peekChar()
      Information provided by the PKI file:
      
          \brief Peek the next character in the buffer
          \return string, the next character in string format
          
              
      Specified by:
      peekChar in interface UsbController
      Returns:
      String Returns a String
    • read

      public int read()
      Information provided by the PKI file:
      
          \brief Read the next character in the buffer - same as readChar()
          \return string, the next character in string format
          
              
      Specified by:
      read in interface UsbController
      Returns:
      int Returns a int
    • peek

      public int peek()
      Information provided by the PKI file:
      
          \brief Peek the next character in the buffer - same as peekChar()
          \return string, the next character in string format
          
              
      Specified by:
      peek in interface UsbController
      Returns:
      int Returns a int
    • write

      public int write(int value)
      Information provided by the PKI file:
      
          \brief Write a character to the console
          \param value, ascii value of the character to be written
          \
          
              
      Specified by:
      write in interface UsbController
      Parameters:
      value - Takes in a parameter of value
      Returns:
      int Returns a int
    • setSerialMonitoring

      public void setSerialMonitoring(boolean bMonitoring)
      Information provided by the PKI file:
      
          \brief Set Serial Monitoring on or off
          \param bMonitoring, true for on and false for off
          
              
      Specified by:
      setSerialMonitoring in interface UsbController
      Parameters:
      bMonitoring - Takes in a parameter of bMonitoring
    • isSerialMonitoring

      public boolean isSerialMonitoring()
      Information provided by the PKI file:
      
          \brief Check if Serial Monitoring is on or off
          \return bool, true for on and false for off
          
              
      Specified by:
      isSerialMonitoring in interface UsbController
      Returns:
      boolean Returns a boolean
    • deployProjectFromFileSystem

      public boolean deployProjectFromFileSystem(String projectName, String path)
      Information provided by the PKI file:
      
          \brief Deploy project from file system
          \param projectName, name of the project in string
          \param path, path of the project in string
          \return bool, true if the project was successfully deployed and false if it's not
          
              
      Specified by:
      deployProjectFromFileSystem in interface UsbController
      Parameters:
      projectName - Takes in a parameter of projectName
      path - Takes in a parameter of path
      Returns:
      boolean Returns a boolean
    • isPortUp

      public boolean isPortUp()
      Information provided by the PKI file:
      
          \brief Check if port is powered on
          \return bool, true if it's powered on and false if it's not
          
              
      Specified by:
      isPortUp in interface UsbController
      Returns:
      boolean Returns a boolean
    • isProtocolUp

      public boolean isProtocolUp()
      Information provided by the PKI file:
      
          \brief Check if port's protocol is up
          \return bool, true if port's protocol is up and false if it's not
          
              
      Specified by:
      isProtocolUp in interface UsbController
      Returns:
      boolean Returns a boolean